Influx Cloud API Service (2.0.1)

Download OpenAPI specification:Download

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint.

Authentication

TokenAuth

InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.

Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.

Example

curl https://us-east-1-1.aws.cloud2.influxdata.com/ --header "Authentication: Token YOUR_API_TOKEN"

For more information and examples, see the following:

Security Scheme Type HTTP
HTTP Authorization Scheme token

BasicAuth

Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):

  • username: InfluxDB Cloud username
  • password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuth

Use InfluxDB 1.x API parameters to provide credentials through the query string.

Username and password schemes require the following credentials:

  • username: InfluxDB Cloud username
  • password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --data-urlencode "u=YOUR_USERNAME" --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type API Key
Query parameter name: u=&p=

Authentication

Use one of the following schemes to authenticate to the InfluxDB API:

TokenAuth

InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.

Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.

Example

curl https://us-east-1-1.aws.cloud2.influxdata.com/ --header "Authentication: Token YOUR_API_TOKEN"

For more information and examples, see the following:

Security Scheme Type HTTP
HTTP Authorization Scheme token

BasicAuth

Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):

  • username: InfluxDB Cloud username
  • password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuth

Use InfluxDB 1.x API parameters to provide credentials through the query string.

Username and password schemes require the following credentials:

  • username: InfluxDB Cloud username
  • password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --data-urlencode "u=YOUR_USERNAME" --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type API Key
Query parameter name: u=&p=

Write

Write time series data to buckets.

Write data

Writes data to a bucket.

To write data into InfluxDB, you need the following:

For more information and examples, see Write data with the InfluxDB API.

query Parameters
org
required
string

The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both orgID and org parameters, org takes precedence.

orgID
string

The parameter value specifies the ID of the destination organization for writes. If both orgID and org are specified, org takes precedence.

bucket
required
string

The destination bucket for writes.

precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for the unix timestamps within the body line-protocol.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, the header value tells the database that compression is applied to the line protocol in the request body.

Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow"

The header value indicates the format of the data in the request body.

Content-Length
integer

The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's max body configuration option, the server responds with status code 413.

Accept
string
Default: application/json
Value: "application/json"

The header value specifies the response format.

Request Body schema: text/plain

Data in line protocol format.

string <byte>

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}

Query

Retrieve data, analyze queries, and get query suggestions.

Generate an Abstract Syntax Tree (AST) from a query

Analyzes flux query and generates a query specification.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Type
string
Value: "application/json"
Request Body schema: application/json

Analyzed Flux query to generate abstract syntax tree.

query
required
string

Flux query script to be analyzed

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "ast": {
    }
}

Retrieve query suggestions

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "funcs": [
    ]
}

Retrieve query suggestions for a branching suggestion

path Parameters
name
required
string

The name of the branching suggestion.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "params": {
    }
}

Analyze an InfluxQL or Flux query

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Type
string
Value: "application/json"
Request Body schema: application/json

Flux or InfluxQL query to analyze

object (File)

Represents a source from a single file

query
required
string

Query script to execute.

type
string
Value: "flux"

The type of query. Must be "flux".

object

Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)

object (Dialect)

Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions

now
string <date-time>

Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Content type
application/json
{
  • "extern": {
    },
  • "query": "string",
  • "type": "flux",
  • "params": { },
  • "dialect": {
    },
  • "now": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Query data

Retrieves data from InfluxDB buckets.

To query data, you need the following:

For more information and examples, see Query with the InfluxDB API.

query Parameters
org
string

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence.

orgID
string

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.

Content-Type
string
Enum: "application/json" "application/vnd.flux"
Request Body schema:

Flux query or specification to execute

One of
object (File)

Represents a source from a single file

query
required
string

Query script to execute.

type
string
Value: "flux"

The type of query. Must be "flux".

object

Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)

object (Dialect)

Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions

now
string <date-time>

Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Content type
Example
{
  • "extern": {
    },
  • "query": "string",
  • "type": "flux",
  • "params": { },
  • "dialect": {
    },
  • "now": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Buckets

List all buckets

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
after
string

The last resource ID from which to seek from (but not including). This is to be used instead of offset.

org
string

The name of the organization.

orgID
string

The organization ID.

name
string

Only returns buckets with a specific name.

id
string

Only returns buckets with a specific ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "buckets": [
    ]
}

Create a bucket

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket to create

orgID
required
string
name
required
string
description
string
rp
string
required
Array of objects (RetentionRules)

Rules to expire or retain data. No rules means data never expires.

schemaType
string (SchemaType)
Enum: "implicit" "explicit"

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "rp": "string",
  • "retentionRules": [
    ],
  • "schemaType": "implicit"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Retrieve a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Update a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket update to apply

name
string
description
string
Array of objects (PatchRetentionRules)

Updates to rules to expire or retain data. No rules means no updates.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "retentionRules": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Delete a bucket

path Parameters
bucketID
required
string

The ID of the bucket to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a bucket

path Parameters
bucketID
required
string

The bucket ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all users with member privileges for a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a bucket

path Parameters
userID
required
string

The ID of the member to remove.

bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a bucket

path Parameters
userID
required
string

The ID of the owner to remove.

bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Dashboards

Retrieve a Dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

query Parameters
include
string
Value: "properties"

Includes the cell view properties in the response if set to properties

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
Example
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Update a dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Patching of a dashboard

name
string

optional, when provided will replace the name

description
string

optional, when provided will replace the description

object (CellWithViewProperties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cells": {
    }
}

Response samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Delete a dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
Array ()
id
string
object
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
viewID
string

The reference to a view from the views API.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Create a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name
string
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
usingView
string

Makes a copy of the provided view.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "usingView": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Delete a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to delete.

cellID
required
string

The ID of the cell to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retrieve the view for a cell

path Parameters
dashboardID
required
string

The dashboard ID.

cellID
required
string

The cell ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

Update the view for a cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
name
required
string
required
LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

List all labels for a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all dashboard members

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a dashboard

path Parameters
userID
required
string

The ID of the member to remove.

dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all dashboard owners

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a dashboard

path Parameters
userID
required
string

The ID of the owner to remove.

dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Create a dashboard

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Dashboard to create

orgID
required
string

The ID of the organization that owns the dashboard.

name
required
string

The user-facing name of the dashboard.

description
string

The user-facing description of the dashboard.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Example
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

List all dashboards

query Parameters
offset
integer >= 0
descending
boolean
Default: false
limit
integer [ -1 .. 100 ]
Default: 20

The non-zero number of dashboards to return

owner
string

A user identifier. Returns only dashboards where this user has the owner role.

sortBy
string
Enum: "ID" "CreatedAt" "UpdatedAt"

The column to sort by.

id
Array of strings

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used.

orgID
string

The identifier of the organization.

org
string

The name of the organization.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "dashboards": [
    ]
}

Tasks

Retrieve a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update a task

Update a task. This will cancel all queued runs.

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task update to apply

status
string (TaskStatusType)
Enum: "active" "inactive"
flux
string

The Flux script to run for this task.

name
string

Override the 'name' option in the flux script.

every
string

Override the 'every' option in the flux script.

cron
string

Override the 'cron' option in the flux script.

offset
string

Override the 'offset' option in the flux script.

description
string

An optional description of the task.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "flux": "string",
  • "name": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Delete a task

Deletes a task and all associated records

path Parameters
taskID
required
string

The ID of the task to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List runs for a task

path Parameters
taskID
required
string

The ID of the task to get runs for.

query Parameters
after
string

Returns runs after a specific ID.

limit
integer [ 1 .. 500 ]
Default: 100

The number of runs to return

afterTime
string <date-time>

Filter runs to those scheduled after this time, RFC3339

beforeTime
string <date-time>

Filter runs to those scheduled before this time, RFC3339

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "runs": [
    ]
}

Manually start a task run, overriding the current schedule

path Parameters
taskID
required
string
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
scheduledFor
string <date-time> Nullable

Time used for run's "now" option, RFC3339. Default is the server's now time.

Responses

Request samples

Content type
application/json
{
  • "scheduledFor": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Retrieve a single run for a task

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Cancel a running task

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retry a task run

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json; charset=utf-8
object

Responses

Request samples

Content type
application/json; charset=utf-8
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Retrieve all logs for a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Retrieve all logs for a run

path Parameters
taskID
required
string

ID of task to get logs for.

runID
required
string

ID of run to get logs for.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

List all labels for a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a task

path Parameters
taskID
required
string

The task ID.

labelID
required
string

The label ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all task members

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a task

path Parameters
userID
required
string

The ID of the member to remove.

taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a task

path Parameters
userID
required
string

The ID of the owner to remove.

taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all tasks

query Parameters
name
string

Returns task with a specific name.

after
string

Return tasks after a specified ID.

user
string

Filter tasks to a specific user ID.

org
string

Filter tasks to a specific organization name.

orgID
string

Filter tasks to a specific organization ID.

status
string
Enum: "active" "inactive"

Filter tasks by a status--"inactive" or "active".

limit
integer [ -1 .. 500 ]
Default: 100

The non-zero number of tasks to return

type
string
Default: ""
Enum: "basic" "system"

Type of task, unset by default.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "tasks": [
    ]
}

Create a new task

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task to create

orgID
string

The ID of the organization that owns this Task.

org
string

The name of the organization that owns this Task.

status
string (TaskStatusType)
Enum: "active" "inactive"
flux
required
string

The Flux script to run for this task.

description
string

An optional description of the task.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "org": "string",
  • "status": "active",
  • "flux": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Authorizations

Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.

List all authorizations

query Parameters
userID
string

Only show authorizations that belong to a user ID.

user
string

Only show authorizations that belong to a user name.

orgID
string

Only show authorizations that belong to an organization ID.

org
string

Only show authorizations that belong to a organization name.

token
string

Find a token by value.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "authorizations": [
    ]
}

Create an authorization

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Authorization to create

status
string
Default: "active"
Enum: "active" "inactive"

If inactive the token is inactive and requests using the token will be rejected.

description
string

A description of the token.

orgID
required
string

ID of org that authorization is scoped to.

required
Array of objects (Permission) non-empty

List of permissions for an auth. An auth must have at least one Permission.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "orgID": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Retrieve an authorization

path Parameters
authID
required
string

The identifier of the authorization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Update authorization status

Update an authorization's status to active or inactive.

path Parameters
authID
required
string

The identifier of the authorization to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The updated Authorization object.

status
string
Default: "active"
Enum: "active" "inactive"

If inactive the token is inactive and requests using the token will be rejected.

description
string

A description of the token.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Delete an authorization

path Parameters
authID
required
string

The identifier of the authorization to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Organizations

List all organizations

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
descending
boolean
Default: false
org
string

Filter organizations to a specific organization name.

orgID
string

Filter organizations to a specific organization ID.

userID
string

Filter organizations to a specific user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "orgs": [
    ]
}

Create an organization

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization to create

name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Retrieve an organization

path Parameters
orgID
required
string

The ID of the organization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Update an organization

path Parameters
orgID
required
string

The ID of the organization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization update to apply

name
string

New name to set on the organization

description
string

New description to set on the organization

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Delete an organization

path Parameters
orgID
required
string

The ID of the organization to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all members of an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from an organization

path Parameters
userID
required
string

The ID of the member to remove.

orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from an organization

path Parameters
userID
required
string

The ID of the owner to remove.

orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Users

Return the feature flags for the currently authenticated user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{ }

Retrieve the currently authenticated user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Update a password

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Update a password

Authorizations:
path Parameters
userID
required
string

The user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all users

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Create a user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to create

oauthID
string
name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

If inactive the user is inactive.

role
string
Enum: "owner" "member"
org_id
string

Responses

Request samples

Content type
application/json
{
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "role": "owner",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Retrieve a user

path Parameters
userID
required
string

The user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Update a user

path Parameters
userID
required
string

The ID of the user to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User update to apply

oauthID
string
name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

If inactive the user is inactive.

role
string
Enum: "owner" "member"
org_id
string

Responses

Request samples

Content type
application/json
{
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "role": "owner",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Delete a user

path Parameters
userID
required
string

The ID of the user to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Ping

Checks the status of InfluxDB instance and version of InfluxDB.

Responses

Checks the status of InfluxDB instance and version of InfluxDB.

Responses

Routes

List all top level routes

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Authorizations

Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.

List all authorizations

query Parameters
userID
string

Only show authorizations that belong to a user ID.

user
string

Only show authorizations that belong to a user name.

orgID
string

Only show authorizations that belong to an organization ID.

org
string

Only show authorizations that belong to a organization name.

token
string

Find a token by value.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "authorizations": [
    ]
}

Create an authorization

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Authorization to create

status
string
Default: "active"
Enum: "active" "inactive"

If inactive the token is inactive and requests using the token will be rejected.

description
string

A description of the token.

orgID
required
string

ID of org that authorization is scoped to.

required
Array of objects (Permission) non-empty

List of permissions for an auth. An auth must have at least one Permission.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "orgID": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Retrieve an authorization

path Parameters
authID
required
string

The identifier of the authorization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Update authorization status

Update an authorization's status to active or inactive.

path Parameters
authID
required
string

The identifier of the authorization to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The updated Authorization object.

status
string
Default: "active"
Enum: "active" "inactive"

If inactive the token is inactive and requests using the token will be rejected.

description
string

A description of the token.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgID": "string",
  • "permissions": [
    ],
  • "id": "string",
  • "token": "string",
  • "userID": "string",
  • "user": "string",
  • "org": "string",
  • "links": {
    }
}

Delete an authorization

path Parameters
authID
required
string

The identifier of the authorization to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Buckets

List all buckets

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
after
string

The last resource ID from which to seek from (but not including). This is to be used instead of offset.

org
string

The name of the organization.

orgID
string

The organization ID.

name
string

Only returns buckets with a specific name.

id
string

Only returns buckets with a specific ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "buckets": [
    ]
}

Create a bucket

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket to create

orgID
required
string
name
required
string
description
string
rp
string
required
Array of objects (RetentionRules)

Rules to expire or retain data. No rules means data never expires.

schemaType
string (SchemaType)
Enum: "implicit" "explicit"

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "rp": "string",
  • "retentionRules": [
    ],
  • "schemaType": "implicit"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Retrieve a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Update a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket update to apply

name
string
description
string
Array of objects (PatchRetentionRules)

Updates to rules to expire or retain data. No rules means no updates.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "retentionRules": [
    ]
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "type": "user",
  • "name": "string",
  • "description": "string",
  • "orgID": "string",
  • "rp": "string",
  • "schemaType": "implicit",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "retentionRules": [
    ],
  • "labels": [
    ]
}

Delete a bucket

path Parameters
bucketID
required
string

The ID of the bucket to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a bucket

path Parameters
bucketID
required
string

The bucket ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all users with member privileges for a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a bucket

path Parameters
userID
required
string

The ID of the member to remove.

bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a bucket

path Parameters
bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a bucket

path Parameters
userID
required
string

The ID of the owner to remove.

bucketID
required
string

The bucket ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Cells

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
Array ()
id
string
object
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
viewID
string

The reference to a view from the views API.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Create a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name
string
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
usingView
string

Makes a copy of the provided view.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "usingView": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Delete a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to delete.

cellID
required
string

The ID of the cell to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retrieve the view for a cell

path Parameters
dashboardID
required
string

The dashboard ID.

cellID
required
string

The cell ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

Update the view for a cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
name
required
string
required
LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

Checks

List all checks

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
orgID
required
string

Only show checks that belong to a specific organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "links": {}
}

Add new check

Request Body schema: application/json

Check to create

name
required
string
orgID
required
string

The ID of the organization that owns this check.

taskID
string

The ID of the task associated with this check.

required
object (DashboardQuery)
status
string (TaskStatusType)
Enum: "active" "inactive"
description
string

An optional description of the check.

Array of objects (Labels)
type
required
string
timeSince
string

String duration before deadman triggers.

staleTime
string

String duration for time that a series is considered stale and should not trigger deadman.

reportZero
boolean

If only zero values reported since time, trigger an alert

level
string (CheckStatusLevel)
Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN"

The state to record if check matches a criteria.

every
string

Check repetition interval.

offset
string

Duration to delay after the schedule, before executing check.

Array of objects

List of tags to write to each status.

statusMessageTemplate
string

The template used to generate and write a status message.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "labels": [
    ],
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Retrieve a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Update a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name
required
string
orgID
required
string

The ID of the organization that owns this check.

taskID
string

The ID of the task associated with this check.

required
object (DashboardQuery)
status
string (TaskStatusType)
Enum: "active" "inactive"
description
string

An optional description of the check.

Array of objects (Labels)
type
required
string
timeSince
string

String duration before deadman triggers.

staleTime
string

String duration for time that a series is considered stale and should not trigger deadman.

reportZero
boolean

If only zero values reported since time, trigger an alert

level
string (CheckStatusLevel)
Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN"

The state to record if check matches a criteria.

every
string

Check repetition interval.

offset
string

Duration to delay after the schedule, before executing check.

Array of objects

List of tags to write to each status.

statusMessageTemplate
string

The template used to generate and write a status message.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "labels": [
    ],
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Update a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name
string
description
string
status
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "active"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "query": {
    },
  • "status": "active",
  • "description": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "deadman",
  • "timeSince": "string",
  • "staleTime": "string",
  • "reportZero": true,
  • "level": "UNKNOWN",
  • "every": "string",
  • "offset": "string",
  • "tags": [
    ],
  • "statusMessageTemplate": "string"
}

Delete a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a check

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete label from a check

path Parameters
checkID
required
string

The check ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retrieve a check query

path Parameters
checkID
required
string

The check ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "flux": "string"
}

DBRPs

List database retention policy mappings

query Parameters
orgID
string

Specifies the organization ID to filter on

org
string

Specifies the organization name to filter on

id
string

Specifies the mapping ID to filter on

bucketID
string

Specifies the bucket ID to filter on

default
boolean

Specifies filtering on default

db
string

Specifies the database to filter on

rp
string

Specifies the retention policy to filter on

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a database retention policy mapping

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The database retention policy mapping to add

orgID
string

the organization ID that owns this mapping.

org
string

the organization that owns this mapping.

bucketID
required
string

the bucket ID used as target for the translation.

database
required
string

InfluxDB v1 database

retention_policy
required
string

InfluxDB v1 retention policy

default
boolean

Specify if this mapping represents the default retention policy for the database specificed.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "org": "string",
  • "bucketID": "string",
  • "database": "string",
  • "retention_policy": "string",
  • "default": true
}

Response samples

Content type
application/json
{}

Retrieve a database retention policy mapping

path Parameters
dbrpID
required
string

The database retention policy mapping ID

query Parameters
orgID
string

Specifies the organization ID of the mapping

org
string

Specifies the organization name of the mapping

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Update a database retention policy mapping

path Parameters
dbrpID
required
string

The database retention policy mapping.

query Parameters
orgID
string

Specifies the organization ID of the mapping

org
string

Specifies the organization name of the mapping

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Database retention policy update to apply

retention_policy
string

InfluxDB v1 retention policy

default
boolean

Responses

Request samples

Content type
application/json
{
  • "retention_policy": "string",
  • "default": true
}

Response samples

Content type
application/json
{}

Delete a database retention policy

path Parameters
dbrpID
required
string

The database retention policy mapping

query Parameters
orgID
string

Specifies the organization ID of the mapping

org
string

Specifies the organization name of the mapping

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Dashboards

Retrieve a Dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

query Parameters
include
string
Value: "properties"

Includes the cell view properties in the response if set to properties

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
Example
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Update a dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Patching of a dashboard

name
string

optional, when provided will replace the name

description
string

optional, when provided will replace the description

object (CellWithViewProperties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cells": {
    }
}

Response samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Delete a dashboard

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
Array ()
id
string
object
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
viewID
string

The reference to a view from the views API.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

Create a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name
string
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>
usingView
string

Makes a copy of the provided view.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "usingView": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
x
integer <int32>
y
integer <int32>
w
integer <int32>
h
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "x": 0,
  • "y": 0,
  • "w": 0,
  • "h": 0,
  • "viewID": "string"
}

Delete a dashboard cell

path Parameters
dashboardID
required
string

The ID of the dashboard to delete.

cellID
required
string

The ID of the cell to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retrieve the view for a cell

path Parameters
dashboardID
required
string

The dashboard ID.

cellID
required
string

The cell ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

Update the view for a cell

path Parameters
dashboardID
required
string

The ID of the dashboard to update.

cellID
required
string

The ID of the cell to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
name
required
string
required
LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "properties": {
    }
}

List all labels for a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all dashboard members

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a dashboard

path Parameters
userID
required
string

The ID of the member to remove.

dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all dashboard owners

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a dashboard

path Parameters
dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a dashboard

path Parameters
userID
required
string

The ID of the owner to remove.

dashboardID
required
string

The dashboard ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Create a dashboard

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Dashboard to create

orgID
required
string

The ID of the organization that owns the dashboard.

name
required
string

The user-facing name of the dashboard.

description
string

The user-facing description of the dashboard.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Example
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "links": {
    },
  • "id": "string",
  • "meta": {
    },
  • "cells": [
    ],
  • "labels": [
    ]
}

List all dashboards

query Parameters
offset
integer >= 0
descending
boolean
Default: false
limit
integer [ -1 .. 100 ]
Default: 20

The non-zero number of dashboards to return

owner
string

A user identifier. Returns only dashboards where this user has the owner role.

sortBy
string
Enum: "ID" "CreatedAt" "UpdatedAt"

The column to sort by.

id
Array of strings

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used.

orgID
string

The identifier of the organization.

org
string

The name of the organization.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "dashboards": [
    ]
}

Delete

Delete data

query Parameters
org
string

Specifies the organization to delete data from.

bucket
string

Specifies the bucket to delete data from.

orgID
string

Specifies the organization ID of the resource.

bucketID
string

Specifies the bucket ID to delete data from.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Deletes data from an InfluxDB bucket.

start
required
string <date-time>

RFC3339Nano

stop
required
string <date-time>

RFC3339Nano

predicate
string

InfluxQL-like delete statement

Responses

Request samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "stop": "2019-08-24T14:15:22Z",
  • "predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

DemoDataBuckets

List of Demo Data Buckets

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "buckets": [
    ]
}

List of Demo Data Buckets

path Parameters
bucketID
required
string

bucket id

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List of Demo Data Buckets

path Parameters
bucketID
required
string

bucket id

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Labels

Create a label

Request Body schema: application/json

Label to create

orgID
required
string
name
required
string
object

Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{}

List all labels

query Parameters
orgID
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Retrieve a label

path Parameters
labelID
required
string

The ID of the label to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Update a label

path Parameters
labelID
required
string

The ID of the label to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label update

name
string
object

Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{}

Delete a label

path Parameters
labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Limits

Retrieve limits for an organization

path Parameters
orgID
required
string

The identifier of the organization.

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "limits": {
    }
}

NotificationEndpoints

List all notification endpoints

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
orgID
required
string

Only show notification endpoints that belong to specific organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "notificationEndpoints": [
    ],
  • "links": {}
}

Add a notification endpoint

Request Body schema: application/json

Notification endpoint to create

id
string
orgID
string
userID
string
description
string

An optional description of the notification endpoint.

name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

The status of the endpoint.

Array of objects (Labels)
type
required
string (NotificationEndpointType)
url
string

Specifies the URL of the Slack endpoint. Specify either URL or Token.

token
string

Specifies the API token string. Specify either URL or Token.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Retrieve a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Update a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

A new notification endpoint to replace the existing endpoint with

id
string
orgID
string
userID
string
description
string

An optional description of the notification endpoint.

name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

The status of the endpoint.

Array of objects (Labels)
type
required
string (NotificationEndpointType)
url
string

Specifies the URL of the Slack endpoint. Specify either URL or Token.

token
string

Specifies the API token string. Specify either URL or Token.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Update a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name
string
description
string
status
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "active"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgID": "string",
  • "userID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "name": "string",
  • "status": "active",
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "url": "string",
  • "token": "string"
}

Delete a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a notification endpoint

path Parameters
endpointID
required
string

The notification endpoint ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

NotificationRules

List all notification rules

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
orgID
required
string

Only show notification rules that belong to a specific organization ID.

checkID
string

Only show notifications that belong to the specific check ID.

tag
string^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$
Example: tag=env:prod

Only return notification rules that "would match" statuses which contain the tag key value pairs provided.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "notificationRules": [
    ],
  • "links": {}
}

Add a notification rule

Request Body schema: application/json

Notification rule to create

endpointID
required
string
orgID
required
string

The ID of the organization that owns this notification rule.

taskID
string

The ID of the task associated with this notification rule.

status
required
string (TaskStatusType)
Enum: "active" "inactive"
name
required
string

Human-readable name describing the notification rule.

sleepUntil
string
every
string

The notification repetition interval.

offset
string

Duration to delay after the schedule, before executing check.

runbookLink
string
limitEvery
integer

Don't notify me more than times every seconds. If set, limit cannot be empty.

limit
integer

Don't notify me more than times every seconds. If set, limitEvery cannot be empty.

Array of objects (TagRule)

List of tag rules the notification rule attempts to match.

description
string

An optional description of the notification rule.

required
Array of objects (StatusRule) non-empty

List of status rules the notification rule attempts to match.

Array of objects (Labels)
type
required
string
channel
string
messageTemplate
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Response samples

Content type
application/json
Example
{
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "id": "string",
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Retrieve a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
Example
{
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "id": "string",
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Update a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Notification rule update to apply

endpointID
required
string
orgID
required
string

The ID of the organization that owns this notification rule.

taskID
string

The ID of the task associated with this notification rule.

status
required
string (TaskStatusType)
Enum: "active" "inactive"
name
required
string

Human-readable name describing the notification rule.

sleepUntil
string
every
string

The notification repetition interval.

offset
string

Duration to delay after the schedule, before executing check.

runbookLink
string
limitEvery
integer

Don't notify me more than times every seconds. If set, limit cannot be empty.

limit
integer

Don't notify me more than times every seconds. If set, limitEvery cannot be empty.

Array of objects (TagRule)

List of tag rules the notification rule attempts to match.

description
string

An optional description of the notification rule.

required
Array of objects (StatusRule) non-empty

List of status rules the notification rule attempts to match.

Array of objects (Labels)
type
required
string
channel
string
messageTemplate
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Response samples

Content type
application/json
Example
{
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "id": "string",
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Update a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Notification rule update to apply

name
string
description
string
status
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "active"
}

Response samples

Content type
application/json
Example
{
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "id": "string",
  • "endpointID": "string",
  • "orgID": "string",
  • "taskID": "string",
  • "ownerID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": "string",
  • "sleepUntil": "string",
  • "every": "string",
  • "offset": "string",
  • "runbookLink": "string",
  • "limitEvery": 0,
  • "limit": 0,
  • "tagRules": [
    ],
  • "description": "string",
  • "statusRules": [
    ],
  • "labels": [
    ],
  • "links": {
    },
  • "type": "slack",
  • "channel": "string",
  • "messageTemplate": "string"
}

Delete a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete label from a notification rule

path Parameters
ruleID
required
string

The notification rule ID.

labelID
required
string

The ID of the label to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Organizations

List all organizations

query Parameters
offset
integer >= 0
limit
integer [ 1 .. 100 ]
Default: 20
descending
boolean
Default: false
org
string

Filter organizations to a specific organization name.

orgID
string

Filter organizations to a specific organization ID.

userID
string

Filter organizations to a specific user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "orgs": [
    ]
}

Create an organization

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization to create

name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Retrieve an organization

path Parameters
orgID
required
string

The ID of the organization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Update an organization

path Parameters
orgID
required
string

The ID of the organization to get.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization update to apply

name
string

New name to set on the organization

description
string

New description to set on the organization

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "links": {
    },
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Delete an organization

path Parameters
orgID
required
string

The ID of the organization to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all members of an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from an organization

path Parameters
userID
required
string

The ID of the member to remove.

orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from an organization

path Parameters
userID
required
string

The ID of the owner to remove.

orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Ping

Checks the status of InfluxDB instance and version of InfluxDB.

Responses

Checks the status of InfluxDB instance and version of InfluxDB.

Responses

Query

Retrieve data, analyze queries, and get query suggestions.

Generate an Abstract Syntax Tree (AST) from a query

Analyzes flux query and generates a query specification.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Type
string
Value: "application/json"
Request Body schema: application/json

Analyzed Flux query to generate abstract syntax tree.

query
required
string

Flux query script to be analyzed

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "ast": {
    }
}

Retrieve query suggestions

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "funcs": [
    ]
}

Retrieve query suggestions for a branching suggestion

path Parameters
name
required
string

The name of the branching suggestion.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "params": {
    }
}

Analyze an InfluxQL or Flux query

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Type
string
Value: "application/json"
Request Body schema: application/json

Flux or InfluxQL query to analyze

object (File)

Represents a source from a single file

query
required
string

Query script to execute.

type
string
Value: "flux"

The type of query. Must be "flux".

object

Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)

object (Dialect)

Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions

now
string <date-time>

Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Content type
application/json
{
  • "extern": {
    },
  • "query": "string",
  • "type": "flux",
  • "params": { },
  • "dialect": {
    },
  • "now": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Query data

Retrieves data from InfluxDB buckets.

To query data, you need the following:

For more information and examples, see Query with the InfluxDB API.

query Parameters
org
string

Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence.

orgID
string

Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.

Content-Type
string
Enum: "application/json" "application/vnd.flux"
Request Body schema:

Flux query or specification to execute

One of
object (File)

Represents a source from a single file

query
required
string

Query script to execute.

type
string
Value: "flux"

The type of query. Must be "flux".

object

Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)

object (Dialect)

Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions

now
string <date-time>

Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Content type
Example
{
  • "extern": {
    },
  • "query": "string",
  • "type": "flux",
  • "params": { },
  • "dialect": {
    },
  • "now": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Routes

List all top level routes

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Rules

Retrieve a notification rule query

path Parameters
ruleID
required
string

The notification rule ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "flux": "string"
}

Secrets

List all secret keys for an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "secrets": [
    ],
  • "links": {
    }
}

Update secrets in an organization

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Secret key value pairs to update/add

property name*
string

Responses

Request samples

Content type
application/json
{
  • "apikey": "abc123xyz"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Delete secrets from an organization Deprecated

path Parameters
orgID
required
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Secret key to delete

secrets
Array of strings

Responses

Request samples

Content type
application/json
{
  • "secrets": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Delete a secret from an organization

path Parameters
orgID
required
string

The organization ID.

secretID
required
string

The secret ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Setup

Retrieve setup status

Check if setup is allowed. Returns true if no default user, organization, or bucket have been created.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "allowed": true
}

Create an initial user, organization, and bucket

Post an onboarding request to create an initial user, organization, and bucket.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Source to create

username
required
string
password
string
org
required
string
bucket
required
string
retentionPeriodHrs
integer
Deprecated
retentionPeriodSeconds
integer
object (Limit)

These are org limits similar to those configured in/by quartz.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "org": "string",
  • "bucket": "string",
  • "retentionPeriodHrs": 0,
  • "retentionPeriodSeconds": 0,
  • "limit": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "org": {
    },
  • "bucket": {
    },
  • "auth": {
    }
}

Create a new user, organization, and bucket

Post an onboarding request to create a new user, organization, and bucket.

Request Body schema: application/json

Source to create

username
required
string
password
string
org
required
string
bucket
required
string
retentionPeriodHrs
integer
Deprecated
retentionPeriodSeconds
integer
object (Limit)

These are org limits similar to those configured in/by quartz.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "org": "string",
  • "bucket": "string",
  • "retentionPeriodHrs": 0,
  • "retentionPeriodSeconds": 0,
  • "limit": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "org": {
    },
  • "bucket": {
    },
  • "auth": {
    }
}

Signin

Create a user session.

Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Signout

Expire the current UI session

Expires the current UI session for the user.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Tasks

Retrieve a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Update a task

Update a task. This will cancel all queued runs.

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task update to apply

status
string (TaskStatusType)
Enum: "active" "inactive"
flux
string

The Flux script to run for this task.

name
string

Override the 'name' option in the flux script.

every
string

Override the 'every' option in the flux script.

cron
string

Override the 'cron' option in the flux script.

offset
string

Override the 'offset' option in the flux script.

description
string

An optional description of the task.

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "flux": "string",
  • "name": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Delete a task

Deletes a task and all associated records

path Parameters
taskID
required
string

The ID of the task to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List runs for a task

path Parameters
taskID
required
string

The ID of the task to get runs for.

query Parameters
after
string

Returns runs after a specific ID.

limit
integer [ 1 .. 500 ]
Default: 100

The number of runs to return

afterTime
string <date-time>

Filter runs to those scheduled after this time, RFC3339

beforeTime
string <date-time>

Filter runs to those scheduled before this time, RFC3339

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "runs": [
    ]
}

Manually start a task run, overriding the current schedule

path Parameters
taskID
required
string
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json
scheduledFor
string <date-time> Nullable

Time used for run's "now" option, RFC3339. Default is the server's now time.

Responses

Request samples

Content type
application/json
{
  • "scheduledFor": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Retrieve a single run for a task

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Cancel a running task

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Retry a task run

path Parameters
taskID
required
string

The task ID.

runID
required
string

The run ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json; charset=utf-8
object

Responses

Request samples

Content type
application/json; charset=utf-8
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "taskID": "string",
  • "status": "scheduled",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Retrieve all logs for a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Retrieve all logs for a run

path Parameters
taskID
required
string

ID of task to get logs for.

runID
required
string

ID of run to get logs for.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

List all labels for a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a task

path Parameters
taskID
required
string

The task ID.

labelID
required
string

The label ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all task members

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a task

path Parameters
userID
required
string

The ID of the member to remove.

taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a task

path Parameters
taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a task

path Parameters
userID
required
string

The ID of the owner to remove.

taskID
required
string

The task ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all tasks

query Parameters
name
string

Returns task with a specific name.

after
string

Return tasks after a specified ID.

user
string

Filter tasks to a specific user ID.

org
string

Filter tasks to a specific organization name.

orgID
string

Filter tasks to a specific organization ID.

status
string
Enum: "active" "inactive"

Filter tasks by a status--"inactive" or "active".

limit
integer [ -1 .. 500 ]
Default: 100

The non-zero number of tasks to return

type
string
Default: ""
Enum: "basic" "system"

Type of task, unset by default.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "tasks": [
    ]
}

Create a new task

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task to create

orgID
string

The ID of the organization that owns this Task.

org
string

The name of the organization that owns this Task.

status
string (TaskStatusType)
Enum: "active" "inactive"
flux
required
string

The Flux script to run for this task.

description
string

An optional description of the task.

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "org": "string",
  • "status": "active",
  • "flux": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "orgID": "string",
  • "org": "string",
  • "name": "string",
  • "ownerID": "string",
  • "description": "string",
  • "status": "active",
  • "labels": [
    ],
  • "authorizationID": "string",
  • "flux": "string",
  • "every": "string",
  • "cron": "string",
  • "offset": "string",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "lastRunStatus": "failed",
  • "lastRunError": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "links": {
    }
}

Telegrafs

List all Telegraf configurations

query Parameters
orgID
string

The organization ID the Telegraf config belongs to.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "configurations": [
    ]
}

Create a Telegraf configuration

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Telegraf configuration to create

name
string
description
string
object
config
string
orgID
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "metadata": {
    },
  • "config": "string",
  • "orgID": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "metadata": {
    },
  • "config": "string",
  • "orgID": "string",
  • "id": "string",
  • "links": {
    },
  • "labels": [
    ]
}

Retrieve a Telegraf configuration

path Parameters
telegrafID
required
string

The Telegraf configuration ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Accept
string
Default: application/toml
Enum: "application/toml" "application/json" "application/octet-stream"

Responses

Response samples

Content type
[agent]
interval = "10s"

Update a Telegraf configuration

path Parameters
telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Telegraf configuration update to apply

name
string
description
string
object
config
string
orgID
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "metadata": {
    },
  • "config": "string",
  • "orgID": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "metadata": {
    },
  • "config": "string",
  • "orgID": "string",
  • "id": "string",
  • "links": {
    },
  • "labels": [
    ]
}

Delete a Telegraf configuration

path Parameters
telegrafID
required
string

The Telegraf configuration ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a Telegraf config

path Parameters
telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a Telegraf config

path Parameters
telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a Telegraf config

path Parameters
telegrafID
required
string

The Telegraf config ID.

labelID
required
string

The label ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all users with member privileges for a Telegraf config

path Parameters
telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a Telegraf config

path Parameters
telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "member"
}

Remove a member from a Telegraf config

path Parameters
userID
required
string

The ID of the member to remove.

telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all owners of a Telegraf configuration

path Parameters
telegrafID
required
string

The Telegraf configuration ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a Telegraf configuration

path Parameters
telegrafID
required
string

The Telegraf configuration ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id
required
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    },
  • "role": "owner"
}

Remove an owner from a Telegraf config

path Parameters
userID
required
string

The ID of the owner to remove.

telegrafID
required
string

The Telegraf config ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Templates

List all templates

query Parameters
org
string

Specifies the name of the organization of the template.

orgID
string

Specifies the organization ID of the template.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Create a template

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Template that will be created

required
object (DocumentMeta)
content
required
object
org
string

The organization Name. Specify either orgID or org.

orgID
string

The organization Name. Specify either orgID or org.

labels
Array of strings

An array of label IDs to be added as labels to the document.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "content": { },
  • "org": "string",
  • "orgID": "string",
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "content": { },
  • "labels": [
    ],
  • "links": {
    }
}

Retrieve a template

path Parameters
templateID
required
string

The template ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "content": { },
  • "labels": [
    ],
  • "links": {
    }
}

Update a template

path Parameters
templateID
required
string

The template ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Template that will be updated

object (DocumentMeta)
content
object

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "content": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "content": { },
  • "labels": [
    ],
  • "links": {
    }
}

Delete a template

path Parameters
templateID
required
string

The template ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all labels for a template

path Parameters
templateID
required
string

The template ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a template

path Parameters
templateID
required
string

The template ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a template

path Parameters
templateID
required
string

The template ID.

labelID
required
string

The label ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List installed templates

query Parameters
orgID
required
string

The organization ID of the stacks

name
string

A collection of names to filter the list by.

stackID
string

A collection of stackIDs to filter the list by.

Responses

Response samples

Content type
application/json
{
  • "stacks": [
    ]
}

Create a new stack

Request Body schema: application/json

The stack to create.

orgID
string
name
string
description
string
urls
Array of strings

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "urls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "orgID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ]
}

Retrieve a stack

path Parameters
stack_id
required
string

The identifier of the stack.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "orgID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ]
}

Update a stack

path Parameters
stack_id
required
string

The identifier of the stack.

Request Body schema: application/json

The stack to update.

name
string Nullable
description
string Nullable
templateURLs
Array of strings Nullable
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "templateURLs": [
    ],
  • "additionalResources": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "orgID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ]
}

Delete a stack and associated resources

path Parameters
stack_id
required
string

The identifier of the stack.

query Parameters
orgID
required
string

The identifier of the organization.

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Uninstall a stack

path Parameters
stack_id
required
string

The identifier of the stack.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "orgID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ]
}

Apply or dry-run a template

Applies or performs a dry-run of template in an organization.

Request Body schema:
dryRun
boolean
orgID
string
stackID
string
object
Array of objects
object
object
Array of objects
Array of objects or objects

Responses

Request samples

Content type
{
  • "dryRun": true,
  • "orgID": "string",
  • "stackID": "string",
  • "template": {
    },
  • "templates": [
    ],
  • "envRefs": {
    },
  • "secrets": {
    },
  • "remotes": [
    ],
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "stackID": "string",
  • "summary": {
    },
  • "diff": {
    },
  • "errors": [
    ]
}

Export a new template

Request Body schema: application/json

Export resources as an InfluxDB template.

One of
stackID
string
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "stackID": "string",
  • "orgIDs": [
    ],
  • "resources": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Usage

Retrieve usage for an organization

path Parameters
orgID
required
string

The identifier of the organization.

query Parameters
start
required
timestamp

start time

stop
timestamp

stop time

raw
boolean
Default: false

return raw usage data

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Users

Return the feature flags for the currently authenticated user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{ }

Retrieve the currently authenticated user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Update a password

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Update a password

Authorizations:
path Parameters
userID
required
string

The user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all users

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Create a user

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to create

oauthID
string
name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

If inactive the user is inactive.

role
string
Enum: "owner" "member"
org_id
string

Responses

Request samples

Content type
application/json
{
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "role": "owner",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Retrieve a user

path Parameters
userID
required
string

The user ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Update a user

path Parameters
userID
required
string

The ID of the user to update.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User update to apply

oauthID
string
name
required
string
status
string
Default: "active"
Enum: "active" "inactive"

If inactive the user is inactive.

role
string
Enum: "owner" "member"
org_id
string

Responses

Request samples

Content type
application/json
{
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "role": "owner",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "oauthID": "string",
  • "name": "string",
  • "status": "active",
  • "links": {
    }
}

Delete a user

path Parameters
userID
required
string

The ID of the user to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Variables

List all labels for a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{}

Add a label to a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID
string

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a variable

path Parameters
variableID
required
string

The variable ID.

labelID
required
string

The label ID to delete.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

List all variables

query Parameters
org
string

The name of the organization.

orgID
string

The organization ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "variables": [
    ]
}

Create a variable

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable to create

orgID
required
string
name
required
string
description
string
selected
Array of strings
sort_order
integer
Array of objects (Labels)
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "links": {},
  • "id": "string",
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "id": "string",
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string"
}

Update a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable update to apply

orgID
required
string
name
required
string
description
string
selected
Array of strings
sort_order
integer
Array of objects (Labels)
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "links": {},
  • "id": "string",
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace a variable

path Parameters
variableID
required
string

The variable ID.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable to replace

orgID
required
string
name
required
string
description
string
selected
Array of strings
sort_order
integer
Array of objects (Labels)
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "links": {},
  • "id": "string",
  • "orgID": "string",
  • "name": "string",
  • "description": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "labels": [
    ],
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Write

Write time series data to buckets.

Write data

Writes data to a bucket.

To write data into InfluxDB, you need the following:

For more information and examples, see Write data with the InfluxDB API.

query Parameters
org
required
string

The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both orgID and org parameters, org takes precedence.

orgID
string

The parameter value specifies the ID of the destination organization for writes. If both orgID and org are specified, org takes precedence.

bucket
required
string

The destination bucket for writes.

precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for the unix timestamps within the body line-protocol.

header Parameters
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, the header value tells the database that compression is applied to the line protocol in the request body.

Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow"

The header value indicates the format of the data in the request body.

Content-Length
integer

The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's max body configuration option, the server responds with status code 413.

Accept
string
Default: application/json
Value: "application/json"

The header value specifies the response format.

Request Body schema: text/plain

Data in line protocol format.

string <byte>

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}